

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
<script type="text/javascript" src="helpman_topicinit.js"></script>

<title>Generate RTF Documentation Dialog [Enterprise Architect User Guide]</title>

<meta name="keywords" content="Enterprise Architect, Sparx Systems, UML, Generate RTF Documentation Dialog,Generate RTF Documentation Dialog Options,Generate RTF Documentation Dialog General Tab,Rich Text Format Generator,Rich Text Format Generator Enhanced,RTF Generator,RTF Generator Enhanced,RTF Report,RTF Report In MS Open Office">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<meta http-equiv="Content-Style-Type" content="text/css" />

<link type="text/css" href="default.css" rel="stylesheet" />
<style type="text/css">
  A, A:Visited
  {
    color: #00F;
  }

  A:Active, A:Hover
  {
    color: #F00;
  }

  OL
  {
    margin: 5px 0 5px 48px;
  }

  UL
  {
    margin-bottom: 3px;
    margin-top: 0;
  }

  #nsr
  {
    background-color: #D4DFFF;
  }

  #nsr A
  {
    text-decoration: none;
  }

  #mainbody
  {
    padding: 8px;
  }

  .p_BodyText
  {
    padding: 5px 0;
  }
</style>



<style type="text/css" media="screen">
  BODY
  {
    background-color: #FFFFFF;
  }

  #nsr
  {
    padding: 6px 6px 0 6px;
    border-bottom: none;
    vertical-align: top;
    z-index: 2;
    visibility: visible;
    left: 0;
    top: 0;
    position: absolute;
  }

  #mainbody
  {
    left: 0;
    top: 0;
    margin: 0;
    position: absolute;
    padding: 10px;
    overflow: auto;
    height: 100%;
    z-index: 1;
    background-repeat: no-repeat;
    background-position: bottom right;
    background-attachment: fixed;
  }
</style>

<style type="text/css" media="print">
  #nsr
  {
    visibility: none;
  }

  #mainbody
  {
    overflow: visible;
  }
</style>
<script type="text/javascript" language="JavaScript" src="nonscroll.js"></script>

</head>
<body scroll="no">

<div id="page">



        <div id="content">
          <div id="content-inner">
          



  
          <div id="nsr">
            <table border="0" cellspacing="0" cellpadding="4" width="100%">
              <tr valign="top">
                <td align="left">
  


                  <p class="p_Heading1"><span class="f_Heading1">Generate RTF Documentation Dialog</span></p>



  
                </td>
                <td align="right">
                  <a href="introduction.htm" onmouseover="document.images.main.src='button_main_h.gif'" onmouseout="document.images.main.src='button_main.gif'">
                    <img name="main" src="button_main.gif" border=0 alt="Return to Introduction">
                  </a>&nbsp;
    
                  <a href="includeorexcludeapackagef.htm" onmouseover="document.images.prev.src='button_prev_h.gif'" onmouseout="document.images.prev.src='button_prev.gif'">
                    <img name=prev src="button_prev.gif" border=0 alt="Previous page" />
                  </a>&nbsp;
    
    
    
                  <a href="rtftemplatesdialog.htm" onmouseover="document.images.next.src='button_next_h.gif'" onmouseout="document.images.next.src='button_next.gif'">
                    <img name=next src="button_next.gif" border=0 alt="Next page" />
                  </a>
    
    
                </td>
              </tr>
            </table>
          </div>
          <div id="mainbody">
  


                <div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" width="952" bgcolor="#efeff7" style="width:952px; background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Note:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td width="952" bgcolor="#f7f7ff" style="width:952px; background-color:#f7f7ff;"><p class="p_TiporNoteText"><span class="f_TiporNoteText">For an introduction to generating RTF documentation, see <a href="rtfdocuments.htm">RTF Documents</a>.</span></p>
</td>
</tr>
</table>
</div>
<p class="p_BodyText"><span class="f_BodyText">The </span><span class="f_UIControl">Generate RTF Documentation</span><span class="f_BodyText"> dialog enables you to set the exact contents and look and feel of your report.</span></p>
<p class="p_TextIndentedL2"><img src="newrtfdialog2.png" width="607" height="425" border="0" alt="NewRTFDialog2"></p>
<p class="p_BodyText"><span class="f_BodyText">Each tab of the dialog offers a number of RTF document generation options, as described in the following sections:</span></p>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_UIControl">Generate</span><span class="f_Bulletlist1"> Tab (see below)</span></li>
</ul>
<ul style="text-indent: 0px; margin-left: 30px; list-style-position: outside;">
<li><span class="f_Bulletlist1"><a href="rtftemplatesdialog.htm">RTF Templates</a></span></li>
<li><span class="f_Bulletlist1"><a href="rtfdocumentoptions.htm">Document Options</a></span></li>
<li><span class="f_Bulletlist1"><a href="rtfdocumentoptions.htm#Advanced">Advanced Options</a></span></li>
<li><span class="f_Bulletlist1"><a href="rtf_element_filters.htm">Element Filters</a></span></li>
<li><span class="f_Bulletlist1"><a href="rtf_document_filters.htm">Other Filters</a></span></li>
<li><span class="f_Bulletlist1"><a href="wordsubstitution.htm">Word Substitution</a></span></li>
<li><span class="f_Bulletlist1"><a href="language_substitution.htm">Language Substitution (Codepage)</a></span></li>
</ul>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Generate Tab Options</span></p>
<p class="p_BodyText"><span class="f_BodyText">The </span><span class="f_UIControl">Generate</span><span class="f_BodyText"> tab of the dialog has the following fields:</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="0" border="0" style="border: none; border-spacing:0px; border-collapse: collapse;">
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="186" bgcolor="#e3e6ed" style="width:186px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Option</span></p>
</td>
<td valign="top" width="592" bgcolor="#e3e6ed" style="width:592px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Use to</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="186" style="width:186px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Model Document</span></p>
<p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">&nbsp;</span></p>
<p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Root Element</span><br>
<span class="f_Tabletext" style="font-weight: bold;">Root Package</span></p>
</td>
<td valign="top" width="592" style="width:592px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Confirm the name of the element selected from the </span><span class="f_UIControl">Project Browser</span><span class="f_Tabletext">, </span><span class="f_UIControl">Element List</span><span class="f_Tabletext"> or </span><span class="f_UIControl">Model Search</span><span class="f_Tabletext">.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">If this is the specially-created model document element for a <a href="virtualdocuments.htm">Virtual Document</a>, the field is </span><span class="f_Tabletext" style="font-weight: bold;">Model Document</span><span class="f_Tabletext">.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Otherwise, this field identifies the selected element of the hierarchy to be reported on; that is, the </span><span class="f_Tabletext" style="font-weight: bold;">Root Element </span><span class="f_Tabletext">or</span><span class="f_Tabletext" style="font-weight: bold;"> Root Package</span><span class="f_Tabletext">.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="186" style="width:186px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Output to File</span></p>
</td>
<td valign="top" width="592" style="width:592px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Type or select the location and filename for the generated documentation. The </span><span class="f_Tabletext" style="font-weight: bold;">[ ... ] </span><span class="f_Tabletext">(Browse)</span><span class="f_MenuKeyField"> </span><span class="f_Tabletext">button enables you to navigate to the location.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="186" style="width:186px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Use Template</span></p>
</td>
<td valign="top" width="592" style="width:592px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Type or select the name of the RTF template to apply to document generation. You can select either a standard template (enclosed in parentheses) or a user-generated template.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="186" style="width:186px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Use Language Substitutions</span></p>
</td>
<td valign="top" width="592" style="width:592px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Switch custom language word substitutions on.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Deselect to switch custom language word substitutions off.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="186" style="width:186px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">View Document On Completion</span></p>
</td>
<td valign="top" width="592" style="width:592px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Open the document as soon as it has been generated.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="186" style="width:186px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Use Internal Viewer</span></p>
</td>
<td valign="top" width="592" style="width:592px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Enable the </span><span class="f_MenuKeyField">View</span><span class="f_Tabletext"> button to launch the generated RTF Documentation in the Enterprise Architect internal viewer.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">Deselect to enable the </span><span class="f_MenuKeyField">View</span><span class="f_Tabletext"> button to launch the generated RTF Documentation in the MS Windows default RTF file viewer.</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 4px 2px 4px 2px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" bgcolor="#efeff7" style="background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Note:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td bgcolor="#f7f7ff" style="background-color:#f7f7ff;"><p class="p_TiporNoteText"><span class="f_TiporNoteText">If you use Open Office as your default document editor, you </span><span class="f_TiporNoteText" style="font-weight: bold;">must</span><span class="f_TiporNoteText"> select the </span><span class="f_MenuKeyField">Overwrite Document Fields</span><span class="f_TiporNoteText"> checkbox in the <a href="rtfdocumentoptions.htm">document options</a> in order to show field value text. Open Office defaults to showing field codes only, and you cannot toggle to the field values.</span></p>
</td>
</tr>
</table>
</div>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="186" style="width:186px; border: solid 1px #000000;"><p class="p_Tabletext"><a name="digel"></a><span class="f_Tabletext" style="font-weight: bold;">Include all Diagram Elements in Report</span></p>
</td>
<td valign="top" width="592" style="width:592px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Include elements from external packages that are referenced from a diagram in the report when the </span><span class="f_Tabletext" style="font-style: italic;">Diagram.Element</span><span class="f_Tabletext"> section is enabled in the selected template.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">When deselected, or when the </span><span class="f_Tabletext" style="font-style: italic;">Diagram.Element</span><span class="f_Tabletext"> section is not enabled in the selected template, only elements in the current package are documented.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="186" style="width:186px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Generate</span></p>
</td>
<td valign="top" width="592" style="width:592px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Generate the document.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="186" style="width:186px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">View</span></p>
</td>
<td valign="top" width="592" style="width:592px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Launch the generated RTF Documentation in the MS Windows default RTF file viewer, or in the Enterprise Architect internal viewer if you have selected the </span><span class="f_MenuKeyField">Use Internal Viewer</span><span class="f_Tabletext"> checkbox.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="186" style="width:186px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Edit Template</span></p>
</td>
<td valign="top" width="592" style="width:592px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Edit the currently-named template using the <a href="rtfstyletemplateeditor.htm">RTF Style Template Editor</a>.</span></p>
<p class="p_Tabletext"><span class="f_Tabletext">You can only edit user-defined templates, not the standard templates provided with Enterprise Architect. Standard template names are enclosed in parentheses.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="186" style="width:186px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Resource Document</span></p>
</td>
<td valign="top" width="592" style="width:592px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Save the current options as a <a href="resource_documents.htm">document definition</a>.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="186" style="width:186px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Abort</span></p>
</td>
<td valign="top" width="592" style="width:592px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Cancel report generation.</span></p>
</td>
</tr>
</table>
</div>




            </div>
          </div>
        </div>



</div>


</body>
</html>
